////////////////////////////////////////////////////////////////////////////////
//                                                                            //
//  Filename:    TigerTreasuresGuts.h                                         //
//  Developer:   Tommy Riddle                                                 //
//  Create date: 09/26/2005                                                   //
//                                                                            //
////////////////////////////////////////////////////////////////////////////////
//                                                                            //
//  Description: This is the class declaration for the slot gut of the        //
//               Australian Slot machine called Tiger Treasures.              //
//                                                                            //
////////////////////////////////////////////////////////////////////////////////
//        Copyright (c) 2005 - Realtime Gaming.  All rights reserved.         //
////////////////////////////////////////////////////////////////////////////////

#if !defined(__TIGERTREASURESGUTS_H__)
#define __TIGERTREASURESGUTS_H__

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000


#include "slotguts.h"
#include "getrand.h"

class TigerTreasuresGuts : public SlotGuts
{
public:
	TigerTreasuresGuts();

	virtual ~TigerTreasuresGuts();

private:
	// Shared enums between client and server
	#include "TigerTreasuresCommon.h"

	// Helpful lookup arrays.
	static SpinResult m_aLineWinSpinResults[NUM_VALID_ICONS][6];

	static SpinResult m_aScatterWinSpinResults[6];

	// Inline functions to use with the arrays that also do
	// bounds checking.
	static SpinResult lookupLineWinSpinResult( uint8 nIconType, uint8 nCount )
	{
		if ( nIconType < NUM_VALID_ICONS && nCount < 6 )
		{
			return m_aLineWinSpinResults[ nIconType ][ nCount ];
		}

		ASSERT( false );
		return EVT_INVALID;
	}

	static SpinResult lookupScatterWinSpinResult( uint8 nCount )
	{
		if ( nCount < 6 )
		{
			return m_aScatterWinSpinResults[ nCount ];
		}

		ASSERT( false );
		return EVT_INVALID;
	}

	enum EvalType
	{
		etLeftToRight,
		etRightToLeft
	};

	// Helper functions for classifyStops.
	SpinResult getLineWinResultWithPossibleSubstitution( uint8* stops,
		EvalType et, bool& bTigerSubstitution ) const;

	bool doesRightToLeftLineWinPayMore( SpinResult srLeftToRight, bool bLeftToRightTigerSubstitution,
		SpinResult srRightToLeft, bool bRightToLeftTigerSubstitution ) const;

	void tryForJackpot( SlotSpin* spin );
	
	SpinResult getScatterWinResult( SlotSpin* spin, EvalType et, int32& scatterPositions ) const;

	void evaluateScatterWin( SlotSpin* spin, SpinResult srScatterResult, int32 scatterPositions );

	void evaluateFeatureTrigger( SlotSpin* spin, SpinResult srScatterResult, int32 scatterPositions );

	void setRightToLeftLineWin( uint8 nLine );
	void resetRightToLeftLineWins();

public:
	virtual void classifyStops( SpinLine* spinline, uint8* stops, uint8 bet, uint8 line,
		uint8& rtnresult, uint8& multiplier );

	virtual void classifyScatters( SlotSpin *spin );

    virtual bool8 isValidGuts();

protected:
	// Override of the framework function.
	virtual void preSpinClassifyResults( SlotSpin *spin );
	virtual void Debug_SetLoserStops( uint8* pStops );

};

#endif // !defined(__TIGERTREASURESGUTS_H__)
